oracle.xdb
Class XMLType

java.lang.Object
oracle.sql.Datum
oracle.sql.DatumWithConnection
oracle.sql.OPAQUE
oracle.xdb.XMLType

All Implemented Interfaces:

oracle.jdbc.internal.ObjectData, oracle.sql.ORAData, java.io.Serializable

public class XMLType

extends oracle.sql.OPAQUE

implements oracle.sql.ORAData

Class that deals with XMLType objects.

See Also:

Serialized Form

Field Summary

static java.lang.String	_SQL_NAME A constant set to SYS.XMLTYPE.
static int	_SQL_TYPECODE A constant set to OPAQUE oracle type.
static int	CONNTYPE_KPRB KPRB connection type.
static int	CONNTYPE_OCI8 OCI8 connection type.
static int	CONNTYPE_THIN Thin connection type.

Fields inherited from class oracle.sql.OPAQUE

BUILD_DATE, PRIVATE_TRACE, TRACE

Constructor Summary

XMLType(java.sql.Connection conn, oracle.sql.BLOB xmlval, int csid)
Construct an XMLType given a BLOB containing the XML data

XMLType(java.sql.Connection conn, oracle.sql.BLOB xmlval, int csid, java.lang.String kind)

XMLType(java.sql.Connection conn, oracle.sql.CLOB xmlval)
Construct an XMLType given a CLOB containing the XML data

XMLType(java.sql.Connection conn, oracle.sql.CLOB xmlval, java.lang.String kind)

XMLType(java.sql.Connection conn, oracle.sql.CLOB xmlval, java.lang.String schemaURL, boolean wellformed, boolean valid)
Construct an XMLType given a CLOB containing the XML data

XMLType(java.sql.Connection conn, oracle.sql.CLOB xmlval, java.lang.String schemaURL, boolean wellformed, boolean valid, java.lang.String kind)

XMLType(java.sql.Connection conn, Document domdoc)
Constructor to create an XMLType given an instance of the DOM document

XMLType(java.sql.Connection conn, java.io.InputStream is)
Construct an XMLType given a InputStream containing the XML data.

XMLType(java.sql.Connection conn, java.io.InputStream is, java.lang.String kind)

XMLType(java.sql.Connection conn, java.lang.String xmlval)
Construct an XMLType given the string containing the XML data

XMLType(java.sql.Connection conn, java.lang.String xmlval, java.lang.String kind)

XMLType(java.sql.Connection conn, java.lang.String xmlval, java.lang.String schemaURL, boolean wellformed, boolean valid)
Construct an XMLType given the string containing the XML data

XMLType(java.sql.Connection conn, java.lang.String xmlval, java.lang.String schemaURL, boolean wellformed, boolean valid, java.lang.String kind)

XMLType(oracle.sql.OpaqueDescriptor type, java.sql.Connection conn, java.lang.Object value)
Create an XMLType given an opaque descriptor, connection and a pickled image.

XMLType(oracle.sql.OpaqueDescriptor type, java.sql.Connection conn, java.lang.Object value, java.lang.String kind)

Method Summary

void	close() Function to free/close the XMLType.
static long	createContext(java.sql.Connection conn)
XMLType	createSchemaBasedXML(java.lang.String schemaURL) Create a schema-based XML
static XMLType	createXML(java.sql.Connection conn, oracle.sql.CLOB xmlval) Create an XMLType given a CLOB containing the XML data
static XMLType	createXML(java.sql.Connection conn, oracle.sql.CLOB xmlval, java.lang.String kind)
static XMLType	createXML(java.sql.Connection conn, oracle.sql.CLOB xmlval, java.lang.String schemaURL, boolean wellformed, boolean valid) Create an XMLType given a CLOB containing the XML data
static XMLType	createXML(java.sql.Connection conn, oracle.sql.CLOB xmlval, java.lang.String schemaURL, boolean wellformed, boolean valid, java.lang.String kind)
static XMLType	createXML(java.sql.Connection conn, Document domdoc) Create an XMLType given an instance of the DOM document
static XMLType	createXML(java.sql.Connection conn, java.io.InputStream is) Create an XMLType given a InputStream containing the XML data.
static XMLType	createXML(java.sql.Connection conn, java.io.InputStream is, java.lang.String kind)
static XMLType	createXML(java.sql.Connection conn, java.lang.String xmlval) Create an XMLType given the string containing the XML data
static XMLType	createXML(java.sql.Connection conn, java.lang.String xmlval, java.lang.String kind)
static XMLType	createXML(java.sql.Connection conn, java.lang.String xmlval, java.lang.String schemaURL, boolean wellformed, boolean valid) Create an XMLType given the string containing the XML data
static XMLType	createXML(java.sql.Connection conn, java.lang.String xmlval, java.lang.String schemaURL, boolean wellformed, boolean valid, java.lang.String kind)
static XMLType	createXML(oracle.sql.OPAQUE opq) Create an XMLType given the opaque type containing the XMLType bytes
static XMLType	createXML(oracle.sql.OPAQUE opq, java.lang.String kind)
static void	destroyContext(long xmctx)
boolean	existsNode(java.lang.String xpath, java.lang.String nsmap) Function to check for the existence of the given set of nodes in the XMLType.
XMLType	extract(java.lang.String xpath, java.lang.String nsmap) Function to extract the given set of nodes from the XMLType.
oracle.sql.BLOB	getBlobVal(int csid) Get the BLOB value containing the XML data from the XMLType.
oracle.sql.CLOB	getClobVal() Get the CLOB value containing the XML data from the XMLType.
static int	getConnType(java.sql.Connection conn) Get the connection type of the given connection.
Document	getDocument() Gets the DOM document associated with the XMLType.
XDBDocFragment	getDocumentFragment() Function to return XDBDocFragment if XMLType instance is a fragment
Document	getDOM() Gets the DOM document associated with the XMLType.
static long	getErrorHandle(java.sql.Connection conn, int conntype) Get the error handle given the connection and the connection type.
java.io.InputStream	getInputStream() Get an InputStream from the XMLType, applications can read XML data from the stream
java.lang.String	getNamespace() return the default namespace of the XMLType document
oracle.sql.NUMBER	getNumberVal() Return the numeric value of the XML document
java.lang.String	getRootElement() Return the root element name
java.lang.String	getSchemaURL() Return the schema URL (i.e. location of the schema to which this XMLType conforms)
static long	getServiceHandle(java.sql.Connection conn, int conntype) Get the service handle given the connection and the connection type.
java.lang.String	getStringVal() Get the string value containing the XML data from the XMLType.
boolean	isFragment() Function to check if the XMLType is a regular document or a document fragment.
boolean	isSchemaBased() Function to check if the XMLType is schema based.
boolean	isSchemaValid(java.lang.String schurl, java.lang.String elname) Function to check if the XMLType is schema based.
boolean	isSchemaValidated() Return TRUE if the document has been validated against its schema
void	schemaValidate() Validate the schema-based document against its own schema.
void	setSchemaValidated(boolean validateFlag) This function sets the VALIDATED flag to indicate that the XMLType has been validated or not.
XMLType	transform(XMLType xsldoc, java.lang.String parammap) Function to transform the XMLType using the given XSL document.
void	writeToOutputStream(java.io.OutputStream os) Write the contents of the XMLType to an OutputStream

Methods inherited from class oracle.sql.OPAQUE

getBytesValue, getDescriptor, getImageLength, getImageOffset, getJavaSqlConnection, getMap, getSQLTypeName, getValue, isConvertibleTo, makeJdbcArray, setDescriptor, setImage, setImageLength, setValue, toBytes, toClass, toClass, toJdbc, toJdbc

Methods inherited from class oracle.sql.DatumWithConnection

assertNotNull, assertNotNull, getConnection, getInternalConnection, getOracleConnection, setPhysicalConnectionOf

Methods inherited from class oracle.sql.Datum

asciiStreamValue, bigDecimalValue, binaryStreamValue, booleanValue, byteValue, characterStreamValue, compareBytes, dateValue, doubleValue, equals, floatValue, getBytes, getLength, getStream, intValue, longValue, setBytes, setShareBytes, shareBytes, stringValue, timestampValue, timeValue

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface oracle.sql.ORAData

toDatum

Field Detail

_SQL_TYPECODE

public static final int _SQL_TYPECODE

A constant set to OPAQUE oracle type. Required for the ORADATA interface.

See Also:

Constant Field Values

_SQL_NAME

public static final java.lang.String _SQL_NAME

A constant set to SYS.XMLTYPE. Required for the ORADATA interface.

See Also:

Constant Field Values

CONNTYPE_THIN

public static final int CONNTYPE_THIN

Thin connection type.

See Also:

Constant Field Values

CONNTYPE_OCI8

public static final int CONNTYPE_OCI8

OCI8 connection type.

See Also:

Constant Field Values

CONNTYPE_KPRB

public static final int CONNTYPE_KPRB

KPRB connection type.

See Also:

Constant Field Values

Constructor Detail

XMLType

public XMLType(java.sql.Connection conn,
               java.lang.String xmlval)
        throws java.sql.SQLException

Construct an XMLType given the string containing the XML data

Parameters:

conn - the connection object to be used.

xmlval - the string containing the XML data

Throws:

java.sql.SQLException

XMLType

public XMLType(java.sql.Connection conn,
               java.lang.String xmlval,
               java.lang.String kind)
        throws java.sql.SQLException

XMLType

public XMLType(java.sql.Connection conn,
               java.lang.String xmlval,
               java.lang.String schemaURL,
               boolean wellformed,
               boolean valid)
        throws java.sql.SQLException

Construct an XMLType given the string containing the XML data

Parameters:

conn - the connection object to be used.

xmlval - the string containing the XML data

schemaURL - the schema URL for the XMLType

wellformed - XML document is well-formed

valid - XML document is valid

Throws:

java.sql.SQLException

XMLType

public XMLType(java.sql.Connection conn,
               java.lang.String xmlval,
               java.lang.String schemaURL,
               boolean wellformed,
               boolean valid,
               java.lang.String kind)
        throws java.sql.SQLException

XMLType

public XMLType(java.sql.Connection conn,
               oracle.sql.CLOB xmlval)
        throws java.sql.SQLException

Construct an XMLType given a CLOB containing the XML data

Parameters:

conn - the connection object to be used.

xmlval - the CLOB containing the XML data

Throws:

java.sql.SQLException

XMLType

public XMLType(java.sql.Connection conn,
               oracle.sql.CLOB xmlval,
               java.lang.String kind)
        throws java.sql.SQLException

XMLType

public XMLType(java.sql.Connection conn,
               oracle.sql.CLOB xmlval,
               java.lang.String schemaURL,
               boolean wellformed,
               boolean valid)
        throws java.sql.SQLException

Construct an XMLType given a CLOB containing the XML data

Parameters:

conn - the connection object to be used.

xmlval - the CLOB containing the XML data

schemaURL - the schema URL for the XMLType

wellformed - XML document is well-formed

valid - XML document is valid

Throws:

java.sql.SQLException

XMLType

public XMLType(java.sql.Connection conn,
               oracle.sql.CLOB xmlval,
               java.lang.String schemaURL,
               boolean wellformed,
               boolean valid,
               java.lang.String kind)
        throws java.sql.SQLException

XMLType

public XMLType(java.sql.Connection conn,
               oracle.sql.BLOB xmlval,
               int csid)
        throws java.sql.SQLException

Construct an XMLType given a BLOB containing the XML data

Parameters:

conn - the connection object to be used.

xmlval - the BLOB containing the XML data

csid - the charset id.

Throws:

java.sql.SQLException

XMLType

public XMLType(java.sql.Connection conn,
               oracle.sql.BLOB xmlval,
               int csid,
               java.lang.String kind)
        throws java.sql.SQLException

XMLType

public XMLType(java.sql.Connection conn,
               java.io.InputStream is)
        throws java.sql.SQLException

Construct an XMLType given a InputStream containing the XML data. Note: This takes the bytes "as is" and puts them into the server. Data must be in the database characterset.

Parameters:

conn - the connection object to be used.

is - the InputStream containing the XML data.

Throws:

java.sql.SQLException

XMLType

public XMLType(java.sql.Connection conn,
               java.io.InputStream is,
               java.lang.String kind)
        throws java.sql.SQLException

XMLType

public XMLType(oracle.sql.OpaqueDescriptor type,
               java.sql.Connection conn,
               java.lang.Object value)
        throws java.sql.SQLException

Create an XMLType given an opaque descriptor, connection and a pickled image.

Parameters:

type - the opaque type descriptor to be used.

conn - the connection object to be used.

value - the pickled image bytes.

Throws:

java.sql.SQLException

XMLType

public XMLType(oracle.sql.OpaqueDescriptor type,
               java.sql.Connection conn,
               java.lang.Object value,
               java.lang.String kind)
        throws java.sql.SQLException

XMLType

public XMLType(java.sql.Connection conn,
               Document domdoc)
        throws java.sql.SQLException

Constructor to create an XMLType given an instance of the DOM document

Parameters:

domdoc - the DOM Document which represents the DOM tree

conn - the connection object to be used.

Throws:

java.sql.SQLException

Method Detail

createXML

public static XMLType createXML(oracle.sql.OPAQUE opq)
                         throws java.sql.SQLException

Create an XMLType given the opaque type containing the XMLType bytes

Parameters:

opq - the opaque data object from which the XMLType is to be generated

Returns:

the created XMLType

Throws:

java.sql.SQLException

createXML

public static XMLType createXML(oracle.sql.OPAQUE opq,
                                java.lang.String kind)
                         throws java.sql.SQLException

Throws:

java.sql.SQLException

createXML

public static XMLType createXML(java.sql.Connection conn,
                                java.lang.String xmlval)
                         throws java.sql.SQLException

Create an XMLType given the string containing the XML data

Parameters:

conn - the connection object to be used.

xmlval - the string containing the XML data

Returns:

the created XMLType

Throws:

java.sql.SQLException

createXML

public static XMLType createXML(java.sql.Connection conn,
                                java.lang.String xmlval,
                                java.lang.String kind)
                         throws java.sql.SQLException

Throws:

java.sql.SQLException

createXML

public static XMLType createXML(java.sql.Connection conn,
                                java.lang.String xmlval,
                                java.lang.String schemaURL,
                                boolean wellformed,
                                boolean valid)
                         throws java.sql.SQLException

Create an XMLType given the string containing the XML data

Parameters:

conn - the connection object to be used.

xmlval - the string containing the XML data

schemaURL - the schema URL for the XMLType

wellformed - XML document is well-formed

valid - XML document is valid

Returns:

the created XMLType

Throws:

java.sql.SQLException

createXML

public static XMLType createXML(java.sql.Connection conn,
                                java.lang.String xmlval,
                                java.lang.String schemaURL,
                                boolean wellformed,
                                boolean valid,
                                java.lang.String kind)
                         throws java.sql.SQLException

Throws:

java.sql.SQLException

createXML

public static XMLType createXML(java.sql.Connection conn,
                                oracle.sql.CLOB xmlval)
                         throws java.sql.SQLException

Create an XMLType given a CLOB containing the XML data

Parameters:

conn - the connection object to be used.

xmlval - the CLOB containing the XML data

Returns:

the created XMLType

Throws:

java.sql.SQLException

createXML

public static XMLType createXML(java.sql.Connection conn,
                                oracle.sql.CLOB xmlval,
                                java.lang.String kind)
                         throws java.sql.SQLException

Throws:

java.sql.SQLException

createXML

public static XMLType createXML(java.sql.Connection conn,
                                oracle.sql.CLOB xmlval,
                                java.lang.String schemaURL,
                                boolean wellformed,
                                boolean valid)
                         throws java.sql.SQLException

Create an XMLType given a CLOB containing the XML data

Parameters:

conn - the connection object to be used.

xmlval - the CLOB containing the XML data

schemaURL - the schema URL for the XMLType

wellformed - XML document is well-formed

valid - XML document is valid

Returns:

the created XMLType

Throws:

java.sql.SQLException

createXML

public static XMLType createXML(java.sql.Connection conn,
                                oracle.sql.CLOB xmlval,
                                java.lang.String schemaURL,
                                boolean wellformed,
                                boolean valid,
                                java.lang.String kind)
                         throws java.sql.SQLException

Throws:

java.sql.SQLException

createXML

public static XMLType createXML(java.sql.Connection conn,
                                java.io.InputStream is)
                         throws java.sql.SQLException

Create an XMLType given a InputStream containing the XML data. Note: This takes the bytes from the InputStream "as is", and sends them into the server. This assumes data is in the database characterset.

Parameters:

conn - the connection object to be used.

is - the InputStream containing the XML data

Returns:

the created XMLType

Throws:

java.sql.SQLException

createXML

public static XMLType createXML(java.sql.Connection conn,
                                java.io.InputStream is,
                                java.lang.String kind)
                         throws java.sql.SQLException

Throws:

java.sql.SQLException

getStringVal

public java.lang.String getStringVal()
                              throws java.sql.SQLException

Get the string value containing the XML data from the XMLType.

Returns:

the string containing the XML data bytes.

Throws:

java.sql.SQLException

getClobVal

public oracle.sql.CLOB getClobVal()
                           throws java.sql.SQLException

Get the CLOB value containing the XML data from the XMLType.

Returns:

the CLOB containing the XML data bytes.

Throws:

java.sql.SQLException

getBlobVal

public oracle.sql.BLOB getBlobVal(int csid)
                           throws java.sql.SQLException

Get the BLOB value containing the XML data from the XMLType.

Parameters:

csid - The character set ID.

Returns:

the BLOB containing the XML data bytes.

Throws:

java.sql.SQLException

getInputStream

public java.io.InputStream getInputStream()
                                   throws java.sql.SQLException

Get an InputStream from the XMLType, applications can read XML data from the stream

Returns:

the InputStream for the XMLType

Throws:

java.sql.SQLException

writeToOutputStream

public void writeToOutputStream(java.io.OutputStream os)
                         throws java.sql.SQLException

Write the contents of the XMLType to an OutputStream

Parameters:

os - The OutputStream to which the contents are written.

Throws:

java.sql.SQLException

createXML

public static XMLType createXML(java.sql.Connection conn,
                                Document domdoc)
                         throws java.sql.SQLException

Create an XMLType given an instance of the DOM document

Parameters:

domdoc - the DOM Document which represents the DOM tree

conn - the JDBC Connection

Returns:

the constructed XMLType.

Throws:

java.sql.SQLException

extract

public XMLType extract(java.lang.String xpath,
                       java.lang.String nsmap)
                throws java.sql.SQLException

Function to extract the given set of nodes from the XMLType. This set of nodes is specified by the xpath expression. The original XMLType remains unchanged. Works only in the thick case

Parameters:

xpath - the xpath expression which specifies the nodes to search for.

nsmap - the map of namespaces which resolves the prefixes in the xpath expression. format is "xmlns=a.com xmlns:b=b.com"

Returns:

XMLType which contains the extracted nodes. null if no nodes match the specified expression.

Throws:

java.sql.SQLException

existsNode

public boolean existsNode(java.lang.String xpath,
                          java.lang.String nsmap)
                   throws java.sql.SQLException

Function to check for the existence of the given set of nodes in the XMLType. This set of nodes is specified by the xpath expression.

Parameters:

xpath - the xpath expression which specifies the nodes to search for.

nsmap - the map of namespaces which resolves the prefixes in the xpath expression. format is "xmlns=a.com xmlns:b=b.com"

Returns:

TRUE if specified nodes exist in the XMLType else FALSE

Throws:

java.sql.SQLException

transform

public XMLType transform(XMLType xsldoc,
                         java.lang.String parammap)
                  throws java.sql.SQLException

Function to transform the XMLType using the given XSL document. The new (transformed) XML document is returned.

Parameters:

xsldoc - the XSL document to be applied to the XMLType

parammap - the top level parameters to be passed to the XSL transformation. This should be of the format "a=b c=d e=f". This can be null.

Returns:

the transformed XMLType

Throws:

java.sql.SQLException

isFragment

public boolean isFragment()
                   throws java.sql.SQLException

Function to check if the XMLType is a regular document or a document fragment.

Returns:

TRUE if doc is a fragment else FALSE

Throws:

java.sql.SQLException

getDocumentFragment

public XDBDocFragment getDocumentFragment()
                                   throws java.sql.SQLException

Function to return XDBDocFragment if XMLType instance is a fragment

Returns:

XDDBDocFragment if XMLType instance is a fragment, else null

Throws:

java.sql.SQLException

isSchemaValid

public boolean isSchemaValid(java.lang.String schurl,
                             java.lang.String elname)
                      throws java.sql.SQLException

Function to check if the XMLType is schema based.

Parameters:

schurl - the URL of the schema to be validated against; if this is null then the documents own schema URL is used (if one exists).

elname - the name of the root element of the schema

Returns:

TRUE if doc is schema based else FALSE

Throws:

java.sql.SQLException

createSchemaBasedXML

public XMLType createSchemaBasedXML(java.lang.String schemaURL)
                             throws java.sql.SQLException

Create a schema-based XML

Parameters:

schemaURL - The schema URL

Returns:

an XMLType object based on the given schema

Throws:

java.sql.SQLException

getRootElement

public java.lang.String getRootElement()
                                throws java.sql.SQLException

Return the root element name

Returns:

the root element name

Throws:

java.sql.SQLException

getSchemaURL

public java.lang.String getSchemaURL()
                              throws java.sql.SQLException

Return the schema URL (i.e. location of the schema to which this XMLType conforms)

Returns:

the schema URL

Throws:

java.sql.SQLException

isSchemaBased

public boolean isSchemaBased()
                      throws java.sql.SQLException

Function to check if the XMLType is schema based.

Returns:

TRUE if doc is schema based else FALSE

Throws:

java.sql.SQLException

getNamespace

public java.lang.String getNamespace()
                              throws java.sql.SQLException

return the default namespace of the XMLType document

Returns:

the namespace of the XMLType document

Throws:

java.sql.SQLException

schemaValidate

public void schemaValidate()
                    throws java.sql.SQLException

Validate the schema-based document against its own schema.

Throws:

java.sql.SQLException

isSchemaValidated

public boolean isSchemaValidated()
                          throws java.sql.SQLException

Return TRUE if the document has been validated against its schema

Returns:

TRUE if the document has been validated against its schema

Throws:

java.sql.SQLException

setSchemaValidated

public void setSchemaValidated(boolean validateFlag)
                        throws java.sql.SQLException

This function sets the VALIDATED flag to indicate that the XMLType has been validated or not.

Parameters:

validateFlag - True indicates that the XMLType has been validated. False indicates that the XMLType has not been validated.

Throws:

java.sql.SQLException

getNumberVal

public oracle.sql.NUMBER getNumberVal()
                               throws java.sql.SQLException

Return the numeric value of the XML document

Returns:

the numeric value of the XML document

Throws:

java.sql.SQLException

getDOM

public Document getDOM()
                throws java.sql.SQLException

Gets the DOM document associated with the XMLType. This document is the org.w3c.dom.Document. The caller can perform all the DOM operations on the Document. If the document is a binary document the getDOM function will return null. NOTE: This function is for the old java APIs. Use getDocument() for the unified APIs

Returns:

the DOM Document object associated with the XMLType

Throws:

java.sql.SQLException

See Also:

Document

getDocument

public Document getDocument()
                     throws java.sql.SQLException

Gets the DOM document associated with the XMLType. This document is the org.w3c.dom.Document. The caller can perform all the DOM operations on the Document. If the document is a binary document the getDOM function will return null.

Returns:

the DOM Document object associated with the XMLType

Throws:

java.sql.SQLException

See Also:

Document

getErrorHandle

public static long getErrorHandle(java.sql.Connection conn,
                                  int conntype)
                           throws java.sql.SQLException

Get the error handle given the connection and the connection type.

Parameters:

conn - The connection

conntype - The connection type.

Returns:

the long describing the error handle.

Throws:

java.sql.SQLException

getServiceHandle

public static long getServiceHandle(java.sql.Connection conn,
                                    int conntype)
                             throws java.sql.SQLException

Get the service handle given the connection and the connection type.

Parameters:

conn - The connection

conntype - The connection type.

Returns:

the long describing the service handle.

Throws:

java.sql.SQLException

close

public void close()

Function to free/close the XMLType. Any operation after this will result in a SQLException. Applications need to call close else a memory leak will result.

getConnType

public static int getConnType(java.sql.Connection conn)
                       throws java.sql.SQLException

Get the connection type of the given connection.

Parameters:

conn - The connection.

Returns:

The connection type.

Throws:

java.sql.SQLException

createContext

public static long createContext(java.sql.Connection conn)
                          throws java.sql.SQLException

Throws:

java.sql.SQLException

destroyContext

public static void destroyContext(long xmctx)
                           throws java.sql.SQLException

Throws:

java.sql.SQLException